home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / util / cli / MayFlower.lha / MayFlower / Dissect / Dissect.doc < prev    next >
Text File  |  1994-05-04  |  5KB  |  113 lines
  1.          --- ---
  2.          (o) (o)           Dissect 2.0 (19940307)
  3.             ^
  4.          \_____/           by Stephen D Childers
  5.  
  6. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  7. Program Description:
  8.  
  9.    1) Dissect a file and give various reports.
  10.  
  11.    2) Can be run from CLI.
  12.       This version of Dissect should not be made resident; program will
  13.       work upon first invocation if resident, but will fail upon
  14.       subsequent invocations.
  15.  
  16.    3) The time required to dissect a 100,000 byte file will be about
  17.       60 seconds with 8MHZ CPU, and about 10 seconds with 25MHZ CPU.
  18.  
  19.    4) Program (when run from CLI) will interact with the 'c:Why' command
  20.       after program failures; this command may provide more information
  21.       as to why the program failed.
  22.  
  23.       The 'Why' command should be used immediately after a program
  24.       failure to extract the last program's result code, because
  25.       that result code is changed upon the execution of the next CLI
  26.       command.
  27.  
  28.    5) Certain error reports will contain the name of the arg, file,
  29.       device, (etc) that is associated with failure when it occurs.
  30.  
  31. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  32. CLI Usage:
  33.  
  34.    Usage > Dissect [?|!] [-options file [tokenfile]]
  35.  
  36.       ? = show some help
  37.       ! = show author info
  38.       -options:
  39.          g = general info (use only on text files)
  40.          c = list characters used (use on any file)
  41.          w = list words used (use only on text files)
  42.            n = print number of words used
  43.            i = ignore case
  44.            ln = lower length limit. Program will ignore words below
  45.                 this length. Default value for n = 1; n must be a
  46.                 decimal value.
  47.            un = upper length limit. Program will ignore words above
  48.                 this length. Default value for n = 4,294,967,295; n must
  49.                 be a decimal value.
  50.  
  51.       file = the file to dissect
  52.  
  53.       tokenfile = a file that defines token (word) indicators
  54.  
  55.    1) The tokenfile argument will allow the user to inform Dissect
  56.       which character symbols to use in detecting a token (word).
  57.  
  58.       The text within file "Dissect.tokens" will explain how to prepare
  59.       and use the tokenfile argument; tokenfile should only be
  60.       used when dissecting text files using option -w.
  61.  
  62.       If the tokenfile argument is not provided by user then the
  63.       internal default is to detect the following letters and symbols as
  64.       part of a token:
  65.                            A-Z :upper case letters
  66.                            a-z :lower case letters
  67.  
  68.       All other symbols and characters not listed will indicate
  69.       end of token when encountered.
  70.  
  71. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  72. CLI Example:
  73.  
  74.     > Dissect -wl3u7 anytext tokenlist
  75.  
  76.     The above example will process all words in which the length is
  77.     within 3 and 7. The formula looks like this:
  78.     length >= 3 and length <= 7.
  79.  
  80. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  81. Version History:
  82.  
  83.    The following information briefly describes changes or improvements
  84.    made to each version, and they will be described in descending order;
  85.    meaning latest version information begins first:
  86.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  87.    Version 2.0 (19940307) -
  88.    1) Changed version numbering format. Program can now be used with the
  89.       "Version" command. Date within parenthesis is shown in a somewhat
  90.       international format as (yyyymmdd).
  91.    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  92.    Version 19930730 - The first version.
  93.  
  94. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  95.        ____ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ____
  96.      __|___|___|___|___|___|___|___|___|___|___|___|___|___|___|___|__
  97.    __|___|___|___|___|___|___|___|___|___|___|___|___|___|___|___|___|__
  98.  __|___|                                                       |___|___|
  99.  |___|__      8   But the fearful, and unbelieving, and the      |___|__
  100.  __|___|   abominable, and murderers, and whoremongers, and      __|___|
  101.  |___|__   sorcerers, and idolaters, and all liars, shall have   |___|__
  102.  __|___|   their part in the lake which burneth with fire        __|___|
  103.  |___|__   and brimstone: which is the second death.           __|___|__
  104.  __|___|__                                                     |___|___|
  105.  |___|___|__     King James Holy Scripture - Revelation 21:8   __|___|__
  106.  __|___|_ _|_ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ ___ _|_ _|___|
  107.  |___|___|___|___|___|___|___|___|___|___|___|___|___|___|___|___|___|
  108.    |___|___|___|___|___|___|___|___|___|___|___|___|___|___|___|___|
  109.  
  110. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  111.                            End Of Document
  112.  
  113.